﻿/*
 * Copyright (c) 2015-2016 Constantijn Evenhuis (blueprints@const.nl)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
using Blueprints.IO;
using System;
using System.IO;

namespace Blueprints.Resolution
{
    /// <summary>
    /// Resolves blueprints from an uri and provides access to them.
    /// </summary>
    public interface IBlueprintResolver
    {
        /// <summary>
        /// Creates a stream to access the blueprint at <paramref name="uri"/>.
        /// </summary>
        /// <param name="uri">The uri to read from.</param>
        /// <param name="mediaType">The media type of the blueprint.</param>
        /// <returns>A stream to read from.</returns>
        Stream CreateReaderStream(Uri uri, out MediaType mediaType);

        /// <summary>
        /// Creates a blueprint reader.
        /// </summary>
        /// <param name="stream">The stream to read from.</param>
        /// <param name="uri">The uri at which the blueprint is located.</param>
        /// <param name="mediaType">The media type of the blueprint.</param>
        /// <returns>The created blueprint reader.</returns>
        IBlueprintReader CreateReader(Stream stream, Uri uri, MediaType mediaType);

        /// <summary>
        /// Creates a blueprint writer.
        /// </summary>
        /// <param name="stream">The stream to write to.</param>
        /// <param name="uri">The uri at which the blueprint is to be stored.</param>
        /// <param name="mediaType">The media type of the blueprint.</param>
        /// <returns>The created blueprint writer.</returns>
        IBlueprintWriter CreateWriter(Stream stream, Uri uri, MediaType mediaType);
    }
}